Skip to main content

Step 4: queryOrder

The Query Order interface can be used to query a payment in the event of an unsuccessful payment notification.

Request Parameters​

HEADER PARAMETERS​

ParameterData TypeM/ODescription
X-APP-KeyStringMFabric App ID, provided by fabric portal of Ethio telecom
AuthorizationStringMApp Token for authentication

REQUEST BODY SCHEMA​

ParameterData TypeM/ODescription
timestampStringMstring <= 13 characters ^[0-9][1-9][0-9]$
Time when a request is sent. UTC timestamp. The unit is second.
methodStringMstring
Value: "payment.queryorder"
Set to 'payment.queryorder', fixed for this interface
nonce_strStringM<= 32 characters \S+
Random character string containing a maximum of 32 characters, including uppercase letters, lowercase letters, digits, but not special characters.
sign_typeStringMValue: "SHA256WithRSA"
Signature type.
signStringM<= 512 characters \S+
This signature is the sign of all the request parameters except the sign and sign_type. First ordered in alphabetical order and joined in a key=value format and joined together with '&' and are signed with the SHA256RSA algorithm.
versionStringM<= 4 characters \S+
Interface version number. Only support 1.0 now
biz_contentobject (AuthTokenResponseBizContent)
appidString(64)M<= 32 characters ^[A-Za-z0-9]+$
Application ID allocated to a merchant by Mobile Payment system.
merch_codeString(128)M<= 16 characters ^[A-Za-z0-9]+$
Short code registered by a merchant with the Mobile Money.
merch_order_idString(64)M<= 64 characters ^[A-Za-z0-9]+$
The order number generated by the merchant side. It must be in the form of letters, numbers, and underscores. Other special characters are not allowed.

Response Parameters​

ParameterData TypeDescription
resultStringSUCCESS or FAIL. When this field is FAIL, the code field is a specific business error code.
codeStringReturn code. 0 is successful, the rest is the business error code
msgStringReturn information, simple error description.
signString(512)<= 512 characters
Response signature.Signed by the privatekey of the SP
nonce_strString(32)<= 32 characters
Random character string. 32 characters or fewer.
sign_typeStringValue: "SHA256WithRSA"
Signature type.
biz_contentobject (AuthTokenResponseBizContent)
merch_order_idString(64)<= 64 characters ^[A-Za-z0-9]+$
Order ID on the merchant side.When return_code is SUCCESS, this value will return
order_statusStringOrder Statuspayment_order_id
trans_timeString
trans_currencyString
total_amountSring